package org.apache.commons.graph.algorithms.elo /*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

/**
 * The player rank
 *
 * @param <P> the player's type
</P> */
interface PlayersRank<P> {
    /**
     * Returns the ranking for the player
     * @param player the player
     * @return Returns the ranking for the player
     */
    fun getRanking(player: P): Double

    /**
     * Update the ranking for the player
     * @param player the player
     * @param ranking the ranking value
     */
    fun updateRanking(player: P, ranking: Double)
}
